get-ready

get-ready

=====

Fork from supershabam/ready

NodeJS mixin to add one-time ready event

Usage

Using ready or ready.mixin to add ready method to the given object.

const ready = require('get-ready');
const obj = {};
ready.mixin(obj);

// register a callback
obj.ready(() => console.log('ready'));

// mark ready
obj.ready(true);

Register

Register a callback to the callback stack, it will be called when mark as ready, see example above.

If the callback is undefined, register will return a promise.

obj.ready().then(() => console.log('ready'));
obj.ready(true);

If it has been ready, the callback will be called immediately.

// already ready
obj.ready(true);
obj.ready().then(() => console.log('ready'));

Warning: the callback is called after nextTick

Emit

Mark it as ready, you can simply using .ready(true).

You can also mark it not ready.

obj.ready(true);
// call immediately
obj.ready(() => console.log('ready'));

obj.ready(false);
obj.ready(() => throw 'don\'t run');

When exception throws, you can pass an error object, then the callback will receive it as the first argument.

obj.ready(err => console.log(err));
obj.ready(new Error('err'));

License

MIT

Changelog

3.0.0 (2023-06-05)

⚠ BREAKING CHANGES

• Drop Node.js < 16.13.0 support

https://github.com/eggjs/egg-core/issues/264

Features

• refactor with typescript (#1) (9eb913f)

2.0.1 / 2017-02-09

• fix: it should reject error when ready return promise (#3)

2.0.0 / 2017-02-08

• feat: [BREAKING_CHANGE] reimplement get-ready (#2)
• fix typo on readme

1.0.0 / 2015-09-29

• chore: use eslint and es6
• test: add test with co
• travis: test on node(1,2,3,4)
• feat: support promise
• fork from supershabam/ready